From 565acecca1fe9276f4475e84147a56c0a2b74f1d Mon Sep 17 00:00:00 2001 From: parkrrrr Date: Thu, 1 Jun 2006 02:22:37 +0000 Subject: [PATCH] More fleshing-out of documentation --- xmldoc/formats/geo.xml | 18 ++++-- xmldoc/formats/google.xml | 25 ++++++-- xmldoc/formats/nmea.xml | 67 ++++++++++---------- xmldoc/formats/options/geo-deficon.xml | 16 +++++ xmldoc/formats/options/geo-nuke_placer.xml | 8 +++ xmldoc/formats/options/geoniche-category.xml | 5 ++ xmldoc/formats/options/nmea-date.xml | 9 +++ xmldoc/formats/options/nmea-gpgga.xml | 9 ++- xmldoc/formats/options/nmea-gpgsa.xml | 11 ++++ xmldoc/formats/options/nmea-gprmc.xml | 10 +++ xmldoc/formats/options/nmea-gpvtg.xml | 10 +++ xmldoc/formats/options/nmea-pause.xml | 30 +++++++++ xmldoc/formats/options/nmea-snlen.xml | 5 ++ xmldoc/formats/options/nmn4-index.xml | 8 +++ xmldoc/formats/options/yahoo-addrsep.xml | 10 ++- xmldoc/formats/yahoo.xml | 1 + 16 files changed, 195 insertions(+), 47 deletions(-) diff --git a/xmldoc/formats/geo.xml b/xmldoc/formats/geo.xml index 22bbd07f5..7cd659e09 100644 --- a/xmldoc/formats/geo.xml +++ b/xmldoc/formats/geo.xml @@ -1,7 +1,11 @@ - - - - geocaching.com spits up geocaching.loc files that are -XML-ish but not quite GPX. Becuase it's so close to GPX, this format -is very well supported. - + +This format supports the Geocaching.com/EasyGPS ".loc" format. This format +was created specifically for Geocaching.com and is not the same as the +standard EasyGPS .loc format. See the EasyGPS +or GPX formats for more general EasyGPS support. + + +This is a simple XML-based format containing only very basic information +about geocaches. If you can use the GPX +format instead, you should consider doing so as it is a much richer format. + diff --git a/xmldoc/formats/google.xml b/xmldoc/formats/google.xml index 33326563f..f564951ae 100644 --- a/xmldoc/formats/google.xml +++ b/xmldoc/formats/google.xml @@ -5,10 +5,27 @@ tack "&output=js" onto the end of a Google Maps route URL (use the "link to this page" option to get a usable URL.) This allows you to plan a route using Google Maps, then download it and use it in your -own mapping program or GPS receiver. If you use a Unix-compatible +own mapping program or GPS receiver. To get a file suitable for use +with GPSBabel, plan your route as usual with Google Maps. Once you've +got it the way you want it, click the "Link to this page" link in the +upper right-hand corner of the Google Maps page. Then, edit the URL +that appears in your address bar by adding "&output=js" (without +the quotes) onto the end. Hit enter, and the resulting page will be +mostly empty. It doesn't look like much, but it contains exactly what +GPSBabel needs. Save it to disk using whatever menu option your web +browser provides. + + +Note that if you are using Microsoft Internet Explorer, you should make sure +to save the web page as "Web Page, HTML Only". If you save it as "Web Page, +Complete", it will be reformatted into a non-XHTML format that GPSBabel +cannot read. + + +If you use a Unix-compatible operating system, this shell script might be useful: - + #!/bin/sh FROM="233 S. Upper Wacker Dr, Chicago, IL" TO="1060 W. Addison St, Chicago, IL" @@ -16,8 +33,4 @@ wget -O - "http://maps.google.com/maps?q=$FROM to $TO&output=js" \ 2&>/dev/null >google_map.js gpsbabel -i google -f google_map.js -o gpx -F google_map.gpx - Note that Internet Explorer has been observed to damage -the XHTML beyond recognition so use a better browser to save the pages -such as Firefox or Mozilla. - diff --git a/xmldoc/formats/nmea.xml b/xmldoc/formats/nmea.xml index a9589f789..955f55e4c 100644 --- a/xmldoc/formats/nmea.xml +++ b/xmldoc/formats/nmea.xml @@ -1,33 +1,36 @@ - - - - This format is the file representation of the NMEA0183 -log and waypoint format. Representative programs include: - - genimap.fi - - - homepages.tig.com.au - - - gpstm.com - - - gpsmaster.nl - - - silcom.com/~rwhately - - - visualgps.net - - - gpsu.co.uk - - - kolumbus.fi - - - commlinkx.com - + + This format is the file representation of the NMEA +(National Marine Electronics Association) 0183 +log and waypoint format for GPS devices. Some hardware and software +that work with NMEA-0183 formatted data include: + + + + GPS Data Logger + + + GPS TrackMaker + + + GPSMaster + + + NMEAlog + + + VisualGPS + + + GPS Utility + + + GeoConv + + + CommLinx GPS recorder + + + SparkFun GPS Datalogger + + diff --git a/xmldoc/formats/options/geo-deficon.xml b/xmldoc/formats/options/geo-deficon.xml index 8b1378917..96d6f27c9 100644 --- a/xmldoc/formats/options/geo-deficon.xml +++ b/xmldoc/formats/options/geo-deficon.xml @@ -1 +1,17 @@ + +This option specifies the icon or waypoint type to write for each waypoint on +output. + + +If this option is specified, its value will be used for all waypoints, not +just those that do not already have descriptions. That is, this option +overrides any icon description that might be in the input file. + + +There is no list of valid values for this option. + + +This option has no effect on input. + + diff --git a/xmldoc/formats/options/geo-nuke_placer.xml b/xmldoc/formats/options/geo-nuke_placer.xml index 8b1378917..50d5a92da 100644 --- a/xmldoc/formats/options/geo-nuke_placer.xml +++ b/xmldoc/formats/options/geo-nuke_placer.xml @@ -1 +1,9 @@ + +If this option is specified, GPSBabel will not read geocache placer information +from a .loc file on input. That is, it will ignore any placeer names in the +input file. + + +This option has no effect on output. + diff --git a/xmldoc/formats/options/geoniche-category.xml b/xmldoc/formats/options/geoniche-category.xml index 8b1378917..7060b96b0 100644 --- a/xmldoc/formats/options/geoniche-category.xml +++ b/xmldoc/formats/options/geoniche-category.xml @@ -1 +1,6 @@ + +This option specifies the name of the category in which to place the +waypoints. If this option is not specified, the default category is +"Cache". + diff --git a/xmldoc/formats/options/nmea-date.xml b/xmldoc/formats/options/nmea-date.xml index 8b1378917..81467a8c9 100644 --- a/xmldoc/formats/options/nmea-date.xml +++ b/xmldoc/formats/options/nmea-date.xml @@ -1 +1,10 @@ + +On input, track points with times but no dates will have this date applied. + + +This is necessary because some NMEA sentences contain times but no dates. If +this option is not specified and the date cannot be determined from one or +more of the available NMEA sentences, the tracks will be discarded. + + diff --git a/xmldoc/formats/options/nmea-gpgga.xml b/xmldoc/formats/options/nmea-gpgga.xml index 8b1378917..2b89b5072 100644 --- a/xmldoc/formats/options/nmea-gpgga.xml +++ b/xmldoc/formats/options/nmea-gpgga.xml @@ -1 +1,8 @@ - + +This option tells GPSBabel whether to read (on input) or write (on output) +GPGGA sentences. The default is to read or write GPGGA sentences. To +disable GPGGA sentences, specify . + + +GPGGA sentences contain the location and quality of the GPS position fix. + diff --git a/xmldoc/formats/options/nmea-gpgsa.xml b/xmldoc/formats/options/nmea-gpgsa.xml index 8b1378917..40412dd84 100644 --- a/xmldoc/formats/options/nmea-gpgsa.xml +++ b/xmldoc/formats/options/nmea-gpgsa.xml @@ -1 +1,12 @@ + +This option tells GPSBabel whether to read (on input) or write (on output) +GPGSA sentences. The default is to read or write GPGSA sentences. To +disable GPGSA sentences, specify . + + +GPGSA sentences contain information on the quality of the positional fix +and the individual satellites from which it was derived. However, GPSBabel +neither reads nor writes the individual satellite data. On input, the +satellite fields are ignored and on output they are left blank. + diff --git a/xmldoc/formats/options/nmea-gprmc.xml b/xmldoc/formats/options/nmea-gprmc.xml index 8b1378917..d6b3f2d1e 100644 --- a/xmldoc/formats/options/nmea-gprmc.xml +++ b/xmldoc/formats/options/nmea-gprmc.xml @@ -1 +1,11 @@ + +This option tells GPSBabel whether to read (on input) or write (on output) +GPRMC sentences. The default is to read or write GPRMC sentences. To +disable GPRMC sentences, specify . + + +GPRMC sentences contain the "recommended mimimum" positional information, +including date and time, heading, and velocity. Note that they do not +include altitude. For altitude, you will have to include GPGGA sentences. + diff --git a/xmldoc/formats/options/nmea-gpvtg.xml b/xmldoc/formats/options/nmea-gpvtg.xml index 8b1378917..85d587517 100644 --- a/xmldoc/formats/options/nmea-gpvtg.xml +++ b/xmldoc/formats/options/nmea-gpvtg.xml @@ -1 +1,11 @@ + +This option tells GPSBabel whether to read (on input) or write (on output) +GPVTG sentences. The default is to read or write GPVTG sentences. To +disable GPVTG sentences, specify . + + +GPVTG sentences contain information about the heading and the speed at the +time of the fix. They do not contain any location information; for that +you will need either or both of GPGGA or GPRMC. + diff --git a/xmldoc/formats/options/nmea-pause.xml b/xmldoc/formats/options/nmea-pause.xml index 8b1378917..72e42ec73 100644 --- a/xmldoc/formats/options/nmea-pause.xml +++ b/xmldoc/formats/options/nmea-pause.xml @@ -1 +1,31 @@ + +This option tells GPSBabel to pause between individual track records when +used on output. This may be used with appropriate external software or +hardware to simulate a GPS receiver for testing purposes. On Unix, for +example, you may use a named pipe to feed the output from GPSBabel to gpsd. + + +If a value for this option is specified, it is in seconds and it may be +either a whole number of seconds or a fraction (e.g. 0.5 for a 1/2 second +pause between trackpoints.) + + +If this option is specified without a value, the time between adjacent +trackpoints will be computed and used for the length of the pause. That is, +if your trackpoints are 5 seconds apart, GPSBabel will pause 5 seconds +between trackpoints. + + +Note that very long tracks may be subject to clock drift, as GPSBabel does +not take into account the amount of time it may take to write the NMEA +sentences. Also, there is no guarantee that it will pause for exactly the +specified number of seconds between samples; different operating systems +will allow greater or lesser precision for timers, so actual precision may +be as much as plus or minus 100 milliseconds. + + +If you are using this option with compressed or simplified tracks from +your handheld GPS receiver, you might find the +interpolate filter useful. + diff --git a/xmldoc/formats/options/nmea-snlen.xml b/xmldoc/formats/options/nmea-snlen.xml index 8b1378917..36e9c734b 100644 --- a/xmldoc/formats/options/nmea-snlen.xml +++ b/xmldoc/formats/options/nmea-snlen.xml @@ -1 +1,6 @@ + +This option specifies the maximum length to be used for waypoint names in +the GPWPL sentence. Longer names will be shortened to no more than this +length, but all waypoint names will remain unique. + diff --git a/xmldoc/formats/options/nmn4-index.xml b/xmldoc/formats/options/nmn4-index.xml index 8b1378917..8b7f0c4f0 100644 --- a/xmldoc/formats/options/nmn4-index.xml +++ b/xmldoc/formats/options/nmn4-index.xml @@ -1 +1,9 @@ + +Because the format supports only one route, this option may be used +on output to select a single route from a collection of +routes read from a more expressive format. If you have, say, a +gpx file that contains two routes, you may +use this option to write them one at a time to individual files. + +gpsbabel -i gpx -f routes.gpx -o nmn4,index=1 -F route1.rte -o nmn4,index=2 -F route2.rte diff --git a/xmldoc/formats/options/yahoo-addrsep.xml b/xmldoc/formats/options/yahoo-addrsep.xml index 8b1378917..249ca3cb4 100644 --- a/xmldoc/formats/options/yahoo-addrsep.xml +++ b/xmldoc/formats/options/yahoo-addrsep.xml @@ -1 +1,9 @@ - + +This option specifies the string GPSBabel should use to separate the parts +of the street address. Since most other formats supported by GPSBabel do +not support street addresses, the street address fields from the Yahoo file +are concatenated into the waypoint "notes" field. + + +The default value for this option is a comma followed by a space (", "). + diff --git a/xmldoc/formats/yahoo.xml b/xmldoc/formats/yahoo.xml index c64225e3a..af379358d 100644 --- a/xmldoc/formats/yahoo.xml +++ b/xmldoc/formats/yahoo.xml @@ -4,3 +4,4 @@ This format reads output from the This feature of GPSBabel makes it easy to get geocoded results from Yahoo into your favorite mapping program, GPS receiver, or other format. + -- 2.30.2